Interface CommonToolbar

All Superinterfaces:
IPCObject
All Known Implementing Classes:
CommonToolbarImpl

public interface CommonToolbar extends IPCObject
Information provided by the PKI file:

    \class CommonToolbar
    
    \brief CommonToolbar allows UI manipulation of the right most vertical toolbar.
    
    \example appWindow().getCommonToolbar()
    
Author:
Auto-generated
  • Method Details

    • setVisible

      void setVisible(boolean bVisible)
      Information provided by the PKI file:
      
          \brief Shows or hides this widget from view.
          
          \param bVisible, true to show this widget, false to hide it.
          
              
      Parameters:
      bVisible - Takes in a parameter of bVisible
    • setWidgetVisible

      void setWidgetVisible(String widgetName, boolean bVisible)
      Information provided by the PKI file:
      
          \brief Shows or hides the specified child widget.
          
          \param widgetName, where widgetName can be one of the following: SelectBtn, MoveBtn, NoteBtn, DeleteBtn, InspectBtn, DrawPolyBtn, AddSimpleBtn, AddComplexPDUBtn.
          \param bVisible, true to show this child widget, false to hide it.
          
              
      Parameters:
      widgetName - Takes in a parameter of widgetName
      bVisible - Takes in a parameter of bVisible
    • setDisabled

      void setDisabled(boolean bDisable)
      Information provided by the PKI file:
      
          \brief Enables or disables input events to this widget.
          
          \param bDisabled, true to disable input events to this widget, false to enable input events.
          
              
      Parameters:
      bDisable - Takes in a parameter of bDisable
    • setWidgetDisable

      void setWidgetDisable(String widgetName, boolean bDisable)
      Information provided by the PKI file:
      
          \brief Enables or disables the specified child widget.
          
          \param widgetName, where widgetName can be one of the following: SelectBtn, MoveBtn, NoteBtn, DeleteBtn, InspectBtn, DrawPolyBtn, AddSimpleBtn, AddComplexPDUBtn.
          \param bDisabled, true to disable input events to this child widget, false to enable input events.
          
              
      Parameters:
      widgetName - Takes in a parameter of widgetName
      bDisable - Takes in a parameter of bDisable
    • changeState

      void changeState(String state)
      Information provided by the PKI file:
      
          \brief Changes the state of the common toolbar.
          
          \param state,       the new state for the Common Toolbar.
          Allowed states:     select,
          move,
          note,
          delete,
          inspect,
          drawpolygon,
          addsimple,
          addcomplex
          
              
      Parameters:
      state - Takes in a parameter of state